Platform Explorer / Nuxeo Platform 5.8

Contribution org.nuxeo.ecm.social.workspace.layout--widgettypes

This contribution is part of XML component org.nuxeo.ecm.social.workspace.layout inside nuxeo-social-workspace-web-5.8.jar

Documentation

The widget types from this contribution are intended to be used in the summary view. All these widgets are bound to the currentDocument in the Seam context. You have the possibility to let access to only administrator to change the visibility, with the parameter "isOnlyAdministrators"

Extension Point

Extension point widgettypes of component WebLayoutManager.

Contributed Items

  • <widgetType name="summary_social_document_visibility_action">
          <configuration>
            <sinceVersion>5.5</sinceVersion>
            <title>Publication of social document</title>
            <description>
              <p>
                This widgets displays the actions of publication on the current document.
              </p>
              <p>
                It requires the following variables to be present in the EL context:
                <ul>
                  <li>currentDocument: the current document</li>
                </ul>
              </p>
            </description>
            <categories>
              <category>listing</category>
            </categories>
            <supportedModes>
              <mode>view</mode>
            </supportedModes>
            <!-- no configurable properties -->
          </configuration>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">
            /widgets/social_document_visibility_widget_template.xhtml
          </property>
        </widgetType>
  • <widgetType name="listing_social_document_consultation">
          <configuration>
            <sinceVersion>5.5</sinceVersion>
            <title>Social document listing widget</title>
            <description>
              <p>
                This widgets displays the title and related actions. To be used in a
                listing of social documents.
              </p>
              <p>
                It supports the following properties:
                <ul>
                  <li>displayActions: display or not the actions (edit, delete, ...) for
                  the document.</li>
                </ul>
              </p>
            </description>
            <categories>
              <category>summary</category>
            </categories>
            <supportedModes>
              <mode>view</mode>
            </supportedModes>
            <!-- no configurable properties -->
          </configuration>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">
            /widgets/listing_social_document_widget_template.xhtml
          </property>
        </widgetType>
  • <widgetType name="userVirtualGroups">
          <configuration>
            <sinceVersion>5.5</sinceVersion>
            <title>User virtual groups</title>
            <description>
              This widget displays the user virtual groups.
            </description>
            <categories>
              <category>document</category>
            </categories>
            <supportedModes>
              <mode>view</mode>
            </supportedModes>
          </configuration>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">
            /widgets/social_collaboration_user_vgoups_widget_template.xhtml
          </property>
        </widgetType>

    This widget displays the user virtual groups.

XML Source

<extension point="widgettypes" target="org.nuxeo.ecm.platform.forms.layout.WebLayoutManager">

    <documentation>
      The widget types from this contribution are intended to be used in the
      summary view. All these widgets are bound to the currentDocument in the
      Seam context.
      You have the possibility to let access to only administrator to change
      the visibility, with the parameter "isOnlyAdministrators"
    </documentation>

    <widgetType name="summary_social_document_visibility_action">
      <configuration>
        <sinceVersion>5.5</sinceVersion>
        <title>Publication of social document</title>
        <description>
          <p>
            This widgets displays the actions of publication on the current document.
          </p>
          <p>
            It requires the following variables to be present in the EL context:
            <ul>
              <li>currentDocument: the current document</li>
            </ul>
          </p>
        </description>
        <categories>
          <category>listing</category>
        </categories>
        <supportedModes>
          <mode>view</mode>
        </supportedModes>
        <!-- no configurable properties -->
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/social_document_visibility_widget_template.xhtml
      </property>
    </widgetType>

    <widgetType name="listing_social_document_consultation">
      <configuration>
        <sinceVersion>5.5</sinceVersion>
        <title>Social document listing widget</title>
        <description>
          <p>
            This widgets displays the title and related actions. To be used in a
            listing of social documents.
          </p>
          <p>
            It supports the following properties:
            <ul>
              <li>displayActions: display or not the actions (edit, delete, ...) for
              the document.</li>
            </ul>
          </p>
        </description>
        <categories>
          <category>summary</category>
        </categories>
        <supportedModes>
          <mode>view</mode>
        </supportedModes>
        <!-- no configurable properties -->
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/listing_social_document_widget_template.xhtml
      </property>
    </widgetType>

    <!-- override the default userVirtualGroups widget type to hide the
    virtual groups referencing social workspace memberships -->
    <widgetType name="userVirtualGroups">
      <configuration>
        <sinceVersion>5.5</sinceVersion>
        <title>User virtual groups</title>
        <description>
          This widget displays the user virtual groups.
        </description>
        <categories>
          <category>document</category>
        </categories>
        <supportedModes>
          <mode>view</mode>
        </supportedModes>
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/social_collaboration_user_vgoups_widget_template.xhtml
      </property>
    </widgetType>

  </extension>